home *** CD-ROM | disk | FTP | other *** search
/ develop, the CD; issue 1 / Apple_Develop_1989.bin / Offscreen / Sample.spotlight / Sample.p < prev    next >
Text File  |  1989-06-19  |  32KB  |  906 lines
  1. {------------------------------------------------------------------------------
  2. #
  3. #    Apple Macintosh Developer Technical Support
  4. #
  5. #    MultiFinder-Aware Simple Sample Application
  6. #
  7. #    Sample
  8. #
  9. #    Sample.p    -    Pascal Source
  10. #
  11. #    Copyright © 1989 Apple Computer, Inc.
  12. #    All rights reserved.
  13. #
  14. #    Versions:    
  15. #                1.00                08/88
  16. #                1.01                11/88
  17. #                1.02                04/89    MPW 3.1
  18. #
  19. #    Components:
  20. #                Sample.p            April 1, 1989
  21. #                Sample.c            April 1, 1989
  22. #                Sample.a            April 1, 1989
  23. #                Sample.inc1.a        April 1, 1989
  24. #                SampleMisc.a        April 1, 1989
  25. #                Sample.r            April 1, 1989
  26. #                Sample.h            April 1, 1989
  27. #                [P]Sample.make        April 1, 1989
  28. #                [C]Sample.make        April 1, 1989
  29. #                [A]Sample.make        April 1, 1989
  30. #
  31. #    Sample is an example application that demonstrates how to
  32. #    initialize the commonly used toolbox managers, operate 
  33. #    successfully under MultiFinder, handle desk accessories, 
  34. #    and create, grow, and zoom windows.
  35. #
  36. #    It does not by any means demonstrate all the techniques 
  37. #    you need for a large application. In particular, Sample 
  38. #    does not cover exception handling, multiple windows/documents, 
  39. #    sophisticated memory management, printing, or undo. All of 
  40. #    these are vital parts of a normal full-sized application.
  41. #
  42. #    This application is an example of the form of a Macintosh 
  43. #    application; it is NOT a template. It is NOT intended to be 
  44. #    used as a foundation for the next world-class, best-selling, 
  45. #    600K application. A stick figure drawing of the human body may 
  46. #    be a good example of the form for a painting, but that does not 
  47. #    mean it should be used as the basis for the next Mona Lisa.
  48. #
  49. #    We recommend that you review this program or TESample before 
  50. #    beginning a new application.
  51. #
  52. ------------------------------------------------------------------------------}
  53.  
  54.  
  55. PROGRAM Sample;
  56.  
  57.  
  58. {Segmentation strategy:
  59.  
  60.  This program consists of three segments. Main contains most of the code,
  61.  including the MPW libraries, and the main program. Initialize contains
  62.  code that is only used once, during startup, and can be unloaded after the
  63.  program starts. %A5Init is automatically created by the Linker to initialize
  64.  globals for the MPW libraries and is unloaded right away.}
  65.  
  66.  
  67. {SetPort strategy:
  68.  
  69.  Toolbox routines do not change the current port. In spite of this, in this
  70.  program we use a strategy of calling SetPort whenever we want to draw or
  71.  make calls which depend on the current port. This makes us less vulnerable
  72.  to bugs in other software which might alter the current port (such as the
  73.  bug (feature?) in many desk accessories which change the port on OpenDeskAcc).
  74.  Hopefully, this also makes the routines from this program more self-contained,
  75.  since they don't depend on the current port setting.}
  76.  
  77.  
  78. USES
  79.     MemTypes, QuickDraw, OSIntf, ToolIntf, PackIntf, Traps;
  80.  
  81. CONST
  82.     {MPW 3.0 will include a Traps.p interface file that includes constants for trap numbers.
  83.      These constants are from that file.}
  84.     {1.02 - since using MPW 3.0 only, we include Traps.p, so we now have trap numbers.}
  85.  
  86.     {1.01 - changed constants to begin with 'k' for consistency, except for resource IDs}
  87.     {SysEnvironsVersion is passed to SysEnvirons to tell it which version of the
  88.      SysEnvRec we understand.}
  89.     kSysEnvironsVersion        = 1;
  90.  
  91.     {OSEvent is the event number of the suspend/resume and mouse-moved events sent
  92.      by MultiFinder. Once we determine that an event is an osEvent, we look at the
  93.      high byte of the message sent to determine which kind it is. To differentiate
  94.      suspend and resume events we check the resumeMask bit.}
  95.     kOSEvent                = app4Evt;    {event used by MultiFinder}
  96.     kSuspendResumeMessage    = 1;        {high byte of suspend/resume event message}
  97.     kResumeMask                = 1;        {bit of message field for resume vs. suspend}
  98.     kNoEvents                = 0;        {no events mask}
  99.  
  100.     {1.01 - kMinHeap - This is the minimum result from the following
  101.      equation:
  102.             
  103.             ORD(GetApplLimit) - ORD(ApplicZone)
  104.             
  105.      for the application to run. It will insure that enough memory will
  106.      be around for reasonable-sized scraps, FKEYs, etc. to exist with the
  107.      application, and still give the application some 'breathing room'.
  108.      To derive this number, we ran under a MultiFinder partition that was
  109.      our requested minimum size, as given in the 'SIZE' resource.}
  110.      
  111.     kMinHeap    = 21 * 1024;
  112.     
  113.     {1.01 - kMinSpace - This is the minimum result from PurgeSpace, when called
  114.      at initialization time, for the application to run. This number acts
  115.      as a double-check to insure that there really is enough memory for the
  116.      application to run, including what has been taken up already by
  117.      pre-loaded resources, the scrap, code, and other sundry memory blocks.}
  118.      
  119.     kMinSpace    = 8 * 1024;
  120.     
  121.     {kExtremeNeg and kExtremePos are used to set up wide open rectangles and regions.}
  122.     kExtremeNeg    = -32768;
  123.     kExtremePos    = 32767 - 1;            {required for old region bug}
  124.     
  125.     {The following constants are all resource IDs, corresponding to resources in Sample.r.}
  126.     rMenuBar    = 128;                    {application's menu bar}
  127.     rAboutAlert    = 128;                    {about alert}
  128.     rUserAlert    = 129;                    {error user alert}
  129.     rWindow        = 128;                    {application's window}
  130.     rStopRect    = 128;                    {rectangle for Stop light}
  131.     rGoRect        = 129;                    {rectangle for Go light}
  132.  
  133.     {The following constants are used to identify menus and their items. The menu IDs
  134.      have an "m" prefix and the item numbers within each menu have an "i" prefix.}
  135.     mApple        = 128;                    {Apple menu}
  136.     iAbout        = 1;
  137.  
  138.     mFile        = 129;                    {File menu}
  139.     iNew        = 1;
  140.     iClose        = 4;
  141.     iQuit        = 12;
  142.  
  143.     mEdit        = 130;                    {Edit menu}
  144.     iUndo        = 1;
  145.     iCut        = 3;
  146.     iCopy        = 4;
  147.     iPaste        = 5;
  148.     iClear        = 6;
  149.  
  150.     mLight        = 131;                    {Light menu}
  151.     iStop        = 1;
  152.     iGo            = 2;
  153.     
  154.     {1.01 - kDITop and kDILeft are used to locate the Disk Initialization dialogs.}
  155.     kDITop        = $0050;
  156.     kDILeft        = $0070;
  157.  
  158.  
  159. VAR
  160.     {The "g" prefix is used to emphasize that a variable is global.}
  161.  
  162.     {GMac is used to hold the result of a SysEnvirons call. This makes
  163.      it convenient for any routine to check the environment. It is
  164.      global information, anyway.}
  165.     gMac                : SysEnvRec;    {set up by Initialize}
  166.  
  167.     {GHasWaitNextEvent is set at startup, and tells whether the WaitNextEvent
  168.      trap is available. If it is false, we know that we must call GetNextEvent.}
  169.     gHasWaitNextEvent    : BOOLEAN;        {set up by Initialize}
  170.  
  171.     {GInBackground is maintained by our osEvent handling routines. Any part of
  172.      the program can check it to find out if it is currently in the background.}
  173.     gInBackground        : BOOLEAN;        {maintained by Initialize and DoEvent}
  174.  
  175.  
  176.     {The following globals are the state of the window. If we supported more than
  177.      one window, they would be attatched to each document, rather than globals.}
  178.  
  179.     {GStopped tells whether the stop light is currently on stop or go.}
  180.     gStopped            : BOOLEAN;        {maintained by Initialize and SetLight}
  181.  
  182.     {GStopRect and gGoRect are the rectangles of the two stop lights in the window.}
  183.     gStopRect            : Rect;            {set up by Initialize}
  184.     gGoRect                : Rect;            {set up by Initialize}
  185.  
  186.  
  187. {$S Initialize}
  188. FUNCTION TrapAvailable(tNumber: INTEGER; tType: TrapType): BOOLEAN;
  189.  
  190. {Check to see if a given trap is implemented. This is only used by the
  191.  Initialize routine in this program, so we put it in the Initialize segment.
  192.  The recommended approach to see if a trap is implemented is to see if
  193.  the address of the trap routine is the same as the address of the
  194.  Unimplemented trap.}
  195. {1.02 - Needs to be called after call to SysEnvirons so that it can check
  196.  if a ToolTrap is out of range of a pre-MacII ROM.}
  197.  
  198. BEGIN
  199.     IF (tType = ToolTrap) &
  200.         (gMac.machineType > envMachUnknown) &
  201.         (gMac.machineType < envMacII) THEN BEGIN        {it's a 512KE, Plus, or SE}
  202.         tNumber := BAND(tNumber, $03FF);
  203.         IF tNumber > $01FF THEN                            {which means the tool traps}
  204.             tNumber := _Unimplemented;                    {only go to $01FF}
  205.     END;
  206.     TrapAvailable := NGetTrapAddress(tNumber, tType) <>
  207.                         GetTrapAddress(_Unimplemented);
  208. END; {TrapAvailable}
  209.  
  210.  
  211. {$S Main}
  212. FUNCTION IsDAWindow(window: WindowPtr): BOOLEAN;
  213.  
  214. {Check if a window belongs to a desk accessory.}
  215.  
  216. BEGIN
  217.     IF window = NIL THEN
  218.         IsDAWindow := FALSE
  219.     ELSE    {DA windows have negative windowKinds}
  220.         IsDAWindow := WindowPeek(window)^.windowKind < 0;
  221. END; {IsDAWindow}
  222.  
  223.  
  224. {$S Main}
  225. FUNCTION IsAppWindow(window: WindowPtr): BOOLEAN;
  226.  
  227. {Check